📟 9. 빈 스코프

@Seongukbaek Posted August 01, 2022 · Updated August 01, 2022 · 21 min read

스프링 핵심 원리 - 기본편을 들으며 정리하는 POST입니다.

🎯 빈 스코프란?

지금까지 우리는 스프링 빈이 스프링 컨테이너의 시작과 함께 생성되어서 스프링 컨테이너가 종료될 때까지 유지된다고 학습했다. 이것은 스프링 빈이 기본적으로 싱글톤 스코프로 생성되기 때문이다. 스코프는 번역 그대로 빈이 존재할 수 있는 범위를 뜻한다.

스프링은 다음과 같은 다양한 스코프를 지원한다.

  • 싱글톤: 기본 스코프, 스프링 컨테이너의 시작과 종료까지 유지되는 가장 넓은 범위의 스코프이다.
  • 프로토타입: 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입까지만 관여하고 더는 관리하지 않는 매우 짧은 범위의 스코프이다.
  • 웹 관련 스코프 : 스프링 웹과 관련된 기능이 들어가야 사용할 수 있는 스코프이다.

    • request: 웹 요청이 들어오고 나갈때 까지 유지되는 스코프이다.
    • session: 웹 세션이 생성되고 종료될 때 까지 유지되는 스코프이다.
    • application: 웹의 서블릿 컨텍스트와 같은 범위로 유지되는 스코프이다.

빈 스코프는 다음과 같이 지정할 수 있다.

컴포넌트 스캔 자동 등록

@Scope("prototype") @Component public class HelloBean {}

수동 등록

@Scope("prototype") @Bean PrototypeBean HelloBean() { return new HelloBean(); }

🎯 프로토타입 스코프

싱글톤 스코프의 빈을 조회하면 스프링 컨테이너는 항상 같은 인스턴스의 스프링 빈을 반환한다. 반면에 프로토타입 스코프를 스프링 컨테이너에 조회하면 스프링 컨테이너는 항상 새로운 인스턴스를 생성해서 반환한다.

싱글톤 빈 요청

  1. 싱글톤 스코프의 빈을 스프링 컨테이너에 요청한다.
  2. 스프링 컨테이너는 본인이 관리하는 스프링 빈을 반환한다.
  3. 이후 스프링 컨테이너에 같은 요청이 와도 같은 객체 인스턴스의 스프링 빈을 반환한다.

프로토타입 빈 요청1      1

  1. 프로토타입 스코프의 빈을 스프링 컨테이너에 요청한다.
  2. 스프링 컨테이너는 이 시점에 프로토타입 빈을 생성하고, 필요한 의존관계를 주입한다.

프로토타입 빈 요청2      2

  1. 스프링 컨테이너는 생성한 프로토타입 빈을 클라이언트에 반환한다.
  2. 이후 스프링 컨테이너에 같은 요청이 오면 항상 새로운 프로토타입 빈을 생성해서 반환한다.

정리

  • 스프링 컨테이너는 프로토타입 빈을 생성하고, 의존관계 주입, 초기화까지만 처리한다.
  • 클라이언트에 빈을 반환하고, 생성된 프로토타입 빈을 관리하지 않는다. 빈에 대한 책임은 프로토타입 빈을 받은 클라이언트에 있다.
  • 따라서, @PreDestroy 같은 종료 메소드가 호출되지 않는다. (클라이언트가 필요하다면, 이를 호출해야 한다.)

싱글톤 스코프 빈 테스트

package hello.core.scope; import org.assertj.core.api.Assertions; import org.junit.jupiter.api.Test; import org.springframework.context.annotation.AnnotationConfigApplicationContext; import org.springframework.context.annotation.Scope; import javax.annotation.PostConstruct; import javax.annotation.PreDestroy; import static org.assertj.core.api.Assertions.*; public class SingletonTest { @Test void singletonBeanFind() { AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SingletonBean.class); SingletonBean singletonBean1 = ac.getBean(SingletonBean.class); SingletonBean singletonBean2 = ac.getBean(SingletonBean.class); System.out.println("singletonBean1 = " + singletonBean1); System.out.println("singletonBean2 = " + singletonBean2); assertThat(singletonBean1).isSameAs(singletonBean2); ac.close(); } @Scope("singleton") static class SingletonBean { @PostConstruct public void init() { System.out.println("SingletonBean.init"); } @PreDestroy public void destroy() { System.out.println("SingletonBean.destroy"); } } } SingletonBean.init singletonBean1 = hello.core.scope.SingletonTest$SingletonBean@6fa51cd4 singletonBean2 = hello.core.scope.SingletonTest$SingletonBean@6fa51cd4 17:04:42.261 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@3c130745, started on Mon Aug 01 17:04:42 KST 2022 SingletonBean.destroy
  • init() 과 destroy() 가 모두 호출된 것을 확인할 수 있다.

프로토타입 스코프 빈 테스트

package hello.core.scope; import org.assertj.core.api.Assertions; import org.junit.jupiter.api.Test; import org.springframework.context.annotation.AnnotationConfigApplicationContext; import org.springframework.context.annotation.Scope; import javax.annotation.PostConstruct; import javax.annotation.PreDestroy; import static org.assertj.core.api.Assertions.*; public class PrototypeTest { @Test void prototypeBeanFind() { AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(PrototypeBean.class); System.out.println("find prototypeBean1"); PrototypeBean prototypeBean1 = ac.getBean(PrototypeBean.class); System.out.println("find prototypeBean2"); PrototypeBean prototypeBean2 = ac.getBean(PrototypeBean.class); System.out.println("prototypeBean1 = " + prototypeBean1); System.out.println("prototypeBean2 = " + prototypeBean2); assertThat(prototypeBean1).isNotSameAs(prototypeBean2); ac.close(); } @Scope("prototype") static class PrototypeBean { @PostConstruct public void init() { System.out.println("PrototypeBean.init"); } @PreDestroy public void destroy() { System.out.println("PrototypeBean.destroy"); } } } find prototypeBean1 PrototypeBean.init find prototypeBean2 PrototypeBean.init prototypeBean1 = hello.core.scope.PrototypeTest$PrototypeBean@6fa51cd4 prototypeBean2 = hello.core.scope.PrototypeTest$PrototypeBean@2767e23c 17:12:05.791 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@3c130745, started on Mon Aug 01 17:12:05 KST 2022
  • 프로토타입 스코프인 경우는 매번 요청마다 새로운 인스턴스를 생성하기에 조회된 두 인스턴스가 다름을 검증해야 한다.
  • 요청이 발생했을 때, 초기화 함수가 호출되는 것을 확인할 수 있고, 종료 메소드는 호출되지 않는다.

    • 싱글톤 빈의 경우는 스프링 컨테이너가 관리하는 책임을 가지기에, 컨테이너 종료 시에 종료 메소드가 호출된다.
    • 따라서, 종료 메소드를 호출할 필요가 있다면, 스프링 컨테이너가 종료되기 전에 명시적으로 종료 메소드를 호출해야 한다.
  • 또한 두 인스턴스가 서로 다른 참조값을 가지는 것을 확인할 수 있다.

🪔 프로토타입 빈의 특징 정리

  • 스프링 컨테이너에 요청할 때마다 새로 생성된다.
  • 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입 그리고 초기화까지만 관여한다.
  • 종료 메서드가 호출되지 않는다.
  • 그래서 프로토타입 빈은 프로토타입 빈을 조회한 클라이언트가 관리해야 한다. 종료 메서드에 대한 호출도 클라이언트가 직접 해야한다.

🎯 프로토타입 스코프 - 싱글톤 빈과 함께 사용 시 문제점

스프링 컨테이너에 프로토타입 스코프의 빈을 요청하면 항상 새로운 객체 인스턴스를 생성해서 반환한다.

하지만 싱글톤 빈과 함께 사용할 때는 의도한 대로 잘 동작하지 않으므로 주의해야 한다.

🪔 스프링 컨테이너에서 프로토타입 빈 직접 요청 1

       1
  1. 클라이언트A는 스프링 컨테이너에 프로토타입 빈을 요청한다.
  2. 스프링 컨테이너는 프로토타입 빈을 새로 생성해서 반환(x01)한다. 해당 빈의 count 필드 값은 0이다.
  3. 클라이언트는 조회한 프로토타입 빈에 addCount() 를 호출하면서 count 필드를 +1 한다. 결과적으로 프로토타입 빈(x01)의 count는 1이 된다.

🪔 스프링 컨테이너에서 프로토타입 빈 직접 요청 2

       2
  1. 클라이언트B는 스프링 컨테이너에 프로토타입 빈을 요청한다.
  2. 스프링 컨테이너는 프로토타입 빈을 새로 생성해서 반환(x02)한다. 해당 빈의 count 필드 값은 0이다.
  3. 클라이언트는 조회한 프로토타입 빈에 addCount() 를 호출하면서 count 필드를 +1 한다. 결과적으로 프로토타입 빈(x02)의 count는 1이 된다.
package hello.core.scope; import org.assertj.core.api.Assertions; import org.junit.jupiter.api.Test; import org.springframework.context.annotation.AnnotationConfigApplicationContext; import org.springframework.context.annotation.Scope; import javax.annotation.PostConstruct; import javax.annotation.PreDestroy; import static org.assertj.core.api.Assertions.*; public class SingletonWithPrototypeTest1 { @Test void prototypeFind() { AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(PrototypeBean.class); PrototypeBean prototypeBean1 = ac.getBean(PrototypeBean.class); prototypeBean1.addCount(); assertThat(prototypeBean1.getCount()).isEqualTo(1); PrototypeBean prototypeBean2 = ac.getBean(PrototypeBean.class); prototypeBean2.addCount(); assertThat(prototypeBean2.getCount()).isEqualTo(1); } @Scope("prototype") static class PrototypeBean { private int count = 0; public void addCount() { count++; } public int getCount() { return count; } @PostConstruct public void init() { System.out.println("PrototypeBean.init" + this); } // 호출되지 않을 것! @PreDestroy public void destroy() { System.out.println("PrototypeBean.destroy" ); } } }
  • 두 인스턴스의 count 모두 1 인 것을 확인할 수 있다.

🪔 싱글톤 빈에서 프로토타입 빈 사용

clientBean 이라는 싱글톤 빈이 의존관계 주입을 통해서 프로토타입 빈을 주입받아서 사용하는 예를 보자.

싱글톤에서 프로토타입 빈 사용1        1

clientBean 은 싱글톤이므로, 보통 스프링 컨테이너 생성 시점에 함께 생성되고, 의존관계 주입도 발생한다.

  1. clientBean 은 의존관계 자동 주입을 사용한다. 주입 시점에 스프링 컨테이너에 프로토타입 빈을 요청한다.
  2. 스프링 컨테이너는 프로토타입 빈을 생성해서 clientBean 에 반환한다. 프로토타입 빈의 count 필드 값은 0이다. (프로토타입 빈의 책임이 싱글톤 빈으로 전가!)

이제 clientBean 은 프로토타입 빈을 내부 필드에 보관한다. (정확히는 참조값을 보관한다.)

싱글톤에서 프로토타입 빈 사용2        2

클라이언트 A는 clientBean 을 스프링 컨테이너에 요청해서 받는다. 싱글톤이므로 항상 같은 clientBean 이 반환된다.

  1. 클라이언트 A는 clientBean.logic() 을 호출한다.
  2. clientBean 은 prototypeBean 의 addCount() 를 호출해서 프로토타입 빈의 count 를 증가한다. count값이 1이 된다.

싱글톤에서 프로토타입 빈 사용3        3

클라이언트 B는 clientBean 을 스프링 컨테이너에 요청해서 받는다.싱글톤이므로 항상 같은 clientBean 이 반환된다.

여기서 중요한 점이 있는데, clientBean이 내부에 가지고 있는 프로토타입 빈은 이미 과거에 주입이 끝난 빈이다. 주입 시점에 스프링 컨테이너에 요청해서 프로토타입 빈이 새로 생성이 된 것이지, 사용 할 때마다 새로 생성되는 것이 아니다!

  1. 클라이언트 B는 clientBean.logic() 을 호출한다.
  2. clientBean 은 prototypeBean 의 addCount() 를 호출해서 프로토타입 빈의 count 를 증가한다. 원래 count 값이 1이었으므로 2가 된다.

테스트 코드

package hello.core.scope; public class SingletonWithPrototypeTest1 { ... @Test void singletonClientUserPrototype() { // ClientBean에 대한 의존관계 자동 주입을 위해 등록 AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(ClientBean.class, PrototypeBean.class); ClientBean clientBean1 = ac.getBean(ClientBean.class); int count1 = clientBean1.logic(); assertThat(count1).isEqualTo(1); ClientBean clientBean2 = ac.getBean(ClientBean.class); int count2 = clientBean2.logic(); assertThat(count2).isEqualTo(2); } // 싱글톤 빈 @Scope("singleton") static class ClientBean { private final PrototypeBean prototypeBean; // 생성자 의존관계 주입 수행 // PrototypeBean을 컨테이너로부터 요청하여 주입받음! // 이제 PrototypeBean은 ClientBean이 관리! public ClientBean(PrototypeBean prototypeBean) { this.prototypeBean = prototypeBean; } public int logic() { prototypeBean.addCount(); return prototypeBean.getCount(); } } @Scope("prototype") static class PrototypeBean { private int count = 0; public void addCount() { count++; } public int getCount() { return count; } @PostConstruct public void init() { System.out.println("PrototypeBean.init" + this); } // 호출되지 않을 것! @PreDestroy public void destroy() { System.out.println("PrototypeBean.destroy" ); } } }
  • 스프링은 일반적으로 싱글톤 빈을 사용하므로, 싱글톤 빈이 프로토타입 빈을 사용하게 된다.
  • 그런데 싱글톤 빈은 생성 시점에만 의존관계 주입을 받기 때문에, 프로토타입 빈이 새로 생성되기는 하지만, 싱글톤 빈과 함께 계속 유지되는 것이 문제다.

아마 원하는 것이 이런 것은 아닐 것이다. 프로토타입 빈을 주입 시점에만 새로 생성하는게 아니라, 사용할 때마다 새로 생성해서 사용하는 것을 원할 것이다. -> 프로토타입이 그런 의미로 사용되는 것이기 때문에!


🎯 프로토타입 스코프 - 싱글톤 빈과 함께 사용 시 Provider로 문제 해결

싱글톤 빈과 프로토타입 빈을 함께 사용할 때, 어떻게 새로운 사용마다 새로운 프로토타입 빈을 생성할 수 있을까?

🪔 스프링 컨테이너에 요청

가장 간단한 방법으로, 싱글톤 빈이 프로토타입을 사용할 때마다 스프링 컨테이너에 새로 요청하는 것이다.

package hello.core.scope; import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.ApplicationContext; import org.springframework.context.annotation.AnnotationConfigApplicationContext; import org.springframework.context.annotation.Scope; import javax.annotation.PostConstruct; import javax.annotation.PreDestroy; import static org.assertj.core.api.Assertions.assertThat; public class PrototypeProviderTest { @Test void providerTest() { AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(ClientBean.class, ClientBean.PrototypeBean.class); ClientBean clientBean1 = ac.getBean(ClientBean.class); int count1 = clientBean1.logic(); assertThat(count1).isEqualTo(1); ClientBean clientBean2 = ac.getBean(ClientBean.class); int count2 = clientBean2.logic(); assertThat(count2).isEqualTo(1); } static class ClientBean { @Autowired private ApplicationContext ac; public int logic() { PrototypeBean prototypeBean = ac.getBean(PrototypeBean.class); prototypeBean.addCount(); int count = prototypeBean.getCount(); return count; } @Scope("prototype") static class PrototypeBean { private int count = 0; public void addCount() { count++; } public int getCount() { return count; } @PostConstruct public void init() { System.out.println("PrototypeBean.init " + this); } @PreDestroy public void destroy() { System.out.println("PrototypeBean.destroy"); } } } }
  • 실행해보면 ac.getBean() 을 통해서 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.
  • 의존관계를 외부에서 주입(DI) 받는게 아니라 이렇게 직접 필요한 의존관계를 찾는 것을 Dependency Lookup (DL) 의존관계 조회(탐색) 이라 한다.
  • 그런데 이렇게 스프링의 애플리케이션 컨텍스트 전체를 주입받게 되면, 스프링 컨테이너에 종속적인 코드가 되고, 단위 테스트도 어려워진다.
  • 지금 필요한 기능은 지정한 프로토타입 빈을 컨테이너에서 대신 찾아주는 DL 정도의 기능만 제공하는 무언가가 있으면 된다.

🪔 ObjectFactory, ObjectProvider

지정한 빈을 컨테이너에서 찾아주는 DL 서비스를 제공하는 것이 ObjectProvider 이다.

  • 과거에는 ObjectFactory 가 있었는데, 여러 편의 기능을 추가해 ObjectProvider 가 탄생했다.
public class SingletonWithPrototypeTest1 { @Test void prototypeFind() { AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(PrototypeBean.class); PrototypeBean prototypeBean1 = ac.getBean(PrototypeBean.class); prototypeBean1.addCount(); assertThat(prototypeBean1.getCount()).isEqualTo(1); PrototypeBean prototypeBean2 = ac.getBean(PrototypeBean.class); prototypeBean2.addCount(); assertThat(prototypeBean2.getCount()).isEqualTo(1); } @Scope("singleton") static class ClientBean { @Autowired private ObjectProvider<PrototypeBean> prototypeBeanProvider; public int logic() { PrototypeBean prototypeBean = prototypeBeanProvider.getObject(); prototypeBean.addCount(); return prototypeBean.getCount(); } } @Scope("prototype") static class PrototypeBean { private int count = 0; public void addCount() { count++; } public int getCount() { return count; } @PostConstruct public void init() { System.out.println("PrototypeBean.init" + this); } // 호출되지 않을 것! @PreDestroy public void destroy() { System.out.println("PrototypeBean.destroy" ); } } } PrototypeBean.init hello.core.scope.SingletonWithPrototypeTest1$PrototypeBean@5032714f PrototypeBean.init hello.core.scope.SingletonWithPrototypeTest1$PrototypeBean@769a1df5
  • 출력 결과를 보면, 프로토타입 빈이 2개 생성된 것을 확인할 수 있다.
  • prototypeBeanProvider.getObject(); 를 통해 스프링 컨테이너에서 빈을 찾아서 반환해준다. -> Dependency Lookup

    • 스프링 컨테이너에서 찾을때, 프로토타입이므로 그때 새로 만들어서 반환한다.
  • 단위테스트를 만들거나 Mock 코드를 만들기 쉬워진다.

ObjectFactory 로 바꿔 수행해도 동작한다.

  • ObjectProvider 는 ObjectFactory 를 상속받아 구현한다.

특징

  • ObjectFactory : 기능이 단순, 별도의 라이브러리가 필요없고 스프링에 의존한다.
  • ObjectProvider : ObjectFactory를 상속받고, 옵션, 스트림 처리 등 편의 기능이 많고, 별도의 라이브러리가 필요없고 스프링에 의존한다.

🪔 JSR-330 Provider

javax.inject.Provider 라는 JSR-330 자바 표준을 사용하는 방법이다. 이를 위해서는 javax.inject:javax.inject:1 라이브러리를 gradle에 추가해야 한다.

// JSR-330 Provider 라이브러리 설정 implementation 'javax.inject:javax.inject:1' public interface Provider<T> { T get(); } @Scope("singleton") static class ClientBean { @Autowired private Provider<PrototypeBean> provider; public int logic() { PrototypeBean prototypeBean = provider.get(); prototypeBean.addCount(); return prototypeBean.getCount(); } }
  • provider.get() 을 통해 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.

    • 이 또한 스프링 컨테이너에서 빈을 찾아 반환해주는 역할을 수행한다. -> DL
  • 자바 표준이고, 기능이 단순해 단위 테스트를 만들거나 mock 코드를 만들기 쉽다.

특징

  • get() 메소드 하나로 기능이 매우 단순하다.
  • 별도의 라이브러리가 필요하다.
  • 자바 표준이므로 스프링에 종속적이지 않다.

프로토타입 빈은 매 사용마다 의존관계 주입이 완료된 새로운 객체가 필요할 때 사용하지만, 실무에서는 싱글톤 빈으로 대부분 문제를 해결하기에 직접적으로 사용할 일은 드물다.


🎯 웹 스코프


🎯 request 스코프 예제 만들기


🎯 스코프와 Provider


🎯 스코프와 프록시

📌 중요한 개념

📕 참고

@Seongukbaek
배우고 정리하고 공유하는 대학생 백성욱입니다 😀